<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
  <meta name="description" content="API docs for the LocaleSettings class from the strings.g library, for the Dart programming language.">
  <title>LocaleSettings class - strings.g library - Dart API</title>


  
  <link rel="preconnect" href="https://fonts.gstatic.com">
  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
  <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@48,400,0,0" rel="stylesheet">
  
  <link rel="stylesheet" href="../static-assets/github.css?v1">
  <link rel="stylesheet" href="../static-assets/styles.css?v1">
  <link rel="icon" href="../static-assets/favicon.png?v1">

  
</head>


<body data-base-href="../" data-using-base-href="false" class="light-theme">

<div id="overlay-under-drawer"></div>

<header id="title">
  <span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
  <ol class="breadcrumbs gt-separated dark hidden-xs">
    <li><a href="../index.html">yuuna</a></li>
    <li><a href="../i18n_strings.g/i18n_strings.g-library.html">strings.g</a></li>
    <li class="self-crumb">LocaleSettings class</li>
  </ol>
  <div class="self-name">LocaleSettings</div>
  <form class="search navbar-right" role="search">
    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
  <div class="toggle" id="theme-button">
    <label for="theme">
      <input type="checkbox" id="theme" value="light-theme">
      <span id="dark-theme-button" class="material-symbols-outlined">
        brightness_4
      </span>
      <span id="light-theme-button" class="material-symbols-outlined">
        brightness_5
      </span>
    </label>
  </div>
</header>
<main>

  <div id="dartdoc-main-content" class="main-content">
      <div>
<h1><span class="kind-class">LocaleSettings</span> class 
 
</h1></div>

    
<section class="desc markdown">
  <p>Manages all translation instances and the current locale</p>
</section>


    <section>
      <dl class="dl-horizontal">
        
  <dt>Inheritance</dt>
  <dd>
    <ul class="gt-separated dark clazz-relationships">
      <li><a href="https://api.flutter.dev/flutter/dart-core/Object-class.html">Object</a></li>
        <li><a href="https://pub.dev/documentation/slang/3.13.0/api_singleton/BaseLocaleSettings-class.html">BaseLocaleSettings</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="../i18n_strings.g/AppLocale.html">AppLocale</a></span>, <span class="type-parameter">_StringsEn</span>&gt;</span></li>
        <li><a href="https://pub.dev/documentation/slang_flutter/3.13.0/slang_flutter/BaseFlutterLocaleSettings-class.html">BaseFlutterLocaleSettings</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="../i18n_strings.g/AppLocale.html">AppLocale</a></span>, <span class="type-parameter">_StringsEn</span>&gt;</span></li>
      <li>LocaleSettings</li>
    </ul>
  </dd>

        
        


        <dt>Available Extensions</dt>
        <dd><ul class="comma-separated clazz-relationships">
          <li><a href="https://pub.dev/documentation/slang_flutter/3.13.0/slang_flutter/ExtBaseLocaleSettings.html">ExtBaseLocaleSettings</a></li>
          <li><a href="https://pub.dev/documentation/slang/3.13.0/api_singleton/LocaleSettingsExt.html">LocaleSettingsExt</a></li>
        </ul></dd>

        


      </dl>
    </section>

    

    <section class="summary offset-anchor inherited" id="instance-properties">
      <h2>Properties</h2>

      <dl class="properties">
        <dt id="hashCode" class="property inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> 

</dt>
<dd class="inherited">
  The hash code for this object.
  <div class="features"><span class="feature">read-only</span><span class="feature">inherited</span></div>

</dd>

        <dt id="runtimeType" class="property inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Type-class.html">Type</a></span> 

</dt>
<dd class="inherited">
  A representation of the runtime type of the object.
  <div class="features"><span class="feature">read-only</span><span class="feature">inherited</span></div>

</dd>

        <dt id="translationMap" class="property inherited">
  <span class="name"><a href="https://pub.dev/documentation/slang/3.13.0/api_singleton/BaseLocaleSettings/translationMap.html">translationMap</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Map-class.html">Map</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="../i18n_strings.g/AppLocale.html">AppLocale</a></span>, <span class="type-parameter">_StringsEn</span>&gt;</span></span> 

</dt>
<dd class="inherited">
  Internal: Manages all translation instances
May be modified when setting a custom plural resolver
  <div class="features"><span class="feature">final</span><span class="feature">inherited</span></div>

</dd>

        <dt id="utils" class="property inherited">
  <span class="name"><a href="https://pub.dev/documentation/slang/3.13.0/api_singleton/BaseLocaleSettings/utils.html">utils</a></span>
  <span class="signature">&#8594; <a href="https://pub.dev/documentation/slang/3.13.0/api_singleton/BaseAppLocaleUtils-class.html">BaseAppLocaleUtils</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="../i18n_strings.g/AppLocale.html">AppLocale</a></span>, <span class="type-parameter">_StringsEn</span>&gt;</span></span> 

</dt>
<dd class="inherited">
  Internal: Reference to utils instance
  <div class="features"><span class="feature">final</span><span class="feature">inherited</span></div>

</dd>

      </dl>
    </section>

    
  <section
      class="summary offset-anchor inherited"
      id="instance-methods">
    <h2>Methods</h2>
    <dl class="callables">
        <dt id="noSuchMethod" class="callable inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Invocation-class.html">Invocation</a></span> <span class="parameter-name">invocation</span></span>)
    <span class="returntype parameter">&#8594; dynamic</span>
  </span>
  

</dt>
<dd class="inherited">
  Invoked when a nonexistent method or property is accessed.
  <div class="features"><span class="feature">inherited</span></div>

</dd>

        <dt id="toString" class="callable inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">toString</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>
  </span>
  

</dt>
<dd class="inherited">
  A string representation of this object.
  <div class="features"><span class="feature">inherited</span></div>

</dd>

        <dt id="updateProviderState" class="callable inherited">
  <span class="name"><a href="https://pub.dev/documentation/slang_flutter/3.13.0/slang_flutter/BaseFlutterLocaleSettings/updateProviderState.html">updateProviderState</a></span><span class="signature">(<wbr><span class="parameter" id="updateProviderState-param-locale"><span class="type-annotation"><a href="../i18n_strings.g/AppLocale.html">AppLocale</a></span> <span class="parameter-name">locale</span>, </span><span class="parameter" id="updateProviderState-param-translations"><span class="type-annotation">_StringsEn</span> <span class="parameter-name">translations</span></span>)
    <span class="returntype parameter">&#8594; void</span>
  </span>
  

</dt>
<dd class="inherited">
  Updates the provider state and therefore triggers a rebuild
on all widgets listening to this provider.
  <div class="features"><span class="feature">inherited</span></div>

</dd>

    </dl>
  </section>
    
  <section
      class="summary offset-anchor inherited"
      id="operators">
    <h2>Operators</h2>
    <dl class="callables">
        <dt id="operator ==" class="callable inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Object-class.html">Object</a></span> <span class="parameter-name">other</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>
  </span>
  

</dt>
<dd class="inherited">
  The equality operator.
  <div class="features"><span class="feature">inherited</span></div>

</dd>

    </dl>
  </section>
    
  <section class="summary offset-anchor" id="static-properties">
    <h2>Static Properties</h2>

    <dl class="properties">
        <dt id="currentLocale" class="property">
  <span class="name"><a href="../i18n_strings.g/LocaleSettings/currentLocale.html">currentLocale</a></span>
  <span class="signature">&#8594; <a href="../i18n_strings.g/AppLocale.html">AppLocale</a></span> 

</dt>
<dd>
  
  <div class="features"><span class="feature">read-only</span></div>

</dd>

        <dt id="instance" class="property">
  <span class="name"><a href="../i18n_strings.g/LocaleSettings/instance.html">instance</a></span>
  <span class="signature">&#8594; <a href="../i18n_strings.g/LocaleSettings-class.html">LocaleSettings</a></span> 

</dt>
<dd>
  
  <div class="features"><span class="feature">final</span></div>

</dd>

        <dt id="supportedLocales" class="property">
  <span class="name"><a class="deprecated" href="../i18n_strings.g/LocaleSettings/supportedLocales.html">supportedLocales</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-ui/Locale-class.html">Locale</a></span>&gt;</span></span> 

</dt>
<dd>
  
  <div class="features"><span class="feature">read-only</span></div>

</dd>

        <dt id="supportedLocalesRaw" class="property">
  <span class="name"><a class="deprecated" href="../i18n_strings.g/LocaleSettings/supportedLocalesRaw.html">supportedLocalesRaw</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>&gt;</span></span> 

</dt>
<dd>
  
  <div class="features"><span class="feature">read-only</span></div>

</dd>

    </dl>
  </section>
    
  <section class="summary offset-anchor" id="static-methods">
    <h2>Static Methods</h2>
    <dl class="callables">
        <dt id="getLocaleStream" class="callable">
  <span class="name"><a href="../i18n_strings.g/LocaleSettings/getLocaleStream.html">getLocaleStream</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-async/Stream-class.html">Stream</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="../i18n_strings.g/AppLocale.html">AppLocale</a></span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  
  

</dd>

        <dt id="setLocale" class="callable">
  <span class="name"><a href="../i18n_strings.g/LocaleSettings/setLocale.html">setLocale</a></span><span class="signature">(<wbr><span class="parameter" id="setLocale-param-locale"><span class="type-annotation"><a href="../i18n_strings.g/AppLocale.html">AppLocale</a></span> <span class="parameter-name">locale</span></span>)
    <span class="returntype parameter">&#8594; <a href="../i18n_strings.g/AppLocale.html">AppLocale</a></span>
  </span>
  

</dt>
<dd>
  
  

</dd>

        <dt id="setLocaleRaw" class="callable">
  <span class="name"><a href="../i18n_strings.g/LocaleSettings/setLocaleRaw.html">setLocaleRaw</a></span><span class="signature">(<wbr><span class="parameter" id="setLocaleRaw-param-rawLocale"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">rawLocale</span></span>)
    <span class="returntype parameter">&#8594; <a href="../i18n_strings.g/AppLocale.html">AppLocale</a></span>
  </span>
  

</dt>
<dd>
  
  

</dd>

        <dt id="setPluralResolver" class="callable">
  <span class="name"><a href="../i18n_strings.g/LocaleSettings/setPluralResolver.html">setPluralResolver</a></span><span class="signature">(<wbr><span class="parameter" id="setPluralResolver-param-language">{<span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a>?</span> <span class="parameter-name">language</span>, </span><span class="parameter" id="setPluralResolver-param-locale"><span class="type-annotation"><a href="../i18n_strings.g/AppLocale.html">AppLocale</a>?</span> <span class="parameter-name">locale</span>, </span><span class="parameter" id="setPluralResolver-param-cardinalResolver"><span class="type-annotation"><a href="https://pub.dev/documentation/slang/3.13.0/api_pluralization/PluralResolver.html">PluralResolver</a>?</span> <span class="parameter-name">cardinalResolver</span>, </span><span class="parameter" id="setPluralResolver-param-ordinalResolver"><span class="type-annotation"><a href="https://pub.dev/documentation/slang/3.13.0/api_pluralization/PluralResolver.html">PluralResolver</a>?</span> <span class="parameter-name">ordinalResolver</span>}</span>)
    <span class="returntype parameter">&#8594; void</span>
  </span>
  

</dt>
<dd>
  
  

</dd>

        <dt id="useDeviceLocale" class="callable">
  <span class="name"><a href="../i18n_strings.g/LocaleSettings/useDeviceLocale.html">useDeviceLocale</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; <a href="../i18n_strings.g/AppLocale.html">AppLocale</a></span>
  </span>
  

</dt>
<dd>
  
  

</dd>

    </dl>
  </section>
    


  </div> <!-- /.main-content -->

  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
    <header id="header-search-sidebar" class="hidden-l">
  <form class="search-sidebar" role="search">
    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
</header>

<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
  <li><a href="../index.html">yuuna</a></li>
  <li><a href="../i18n_strings.g/i18n_strings.g-library.html">strings.g</a></li>
  <li class="self-crumb">LocaleSettings class</li>
</ol>


    <h5>strings.g library</h5>
    <ol>
      <li class="section-title"><a href="../i18n_strings.g/i18n_strings.g-library.html#classes">Classes</a></li>
        <li><a href="../i18n_strings.g/AppLocaleUtils-class.html">AppLocaleUtils</a></li>
        <li><a href="https://pub.dev/documentation/slang/3.13.0/api_locale/BaseAppLocale-class.html">BaseAppLocale</a></li>
        <li><a href="https://pub.dev/documentation/slang/3.13.0/api_singleton/BaseAppLocaleUtils-class.html">BaseAppLocaleUtils</a></li>
        <li><a href="https://pub.dev/documentation/slang_flutter/3.13.0/slang_flutter/BaseFlutterLocaleSettings-class.html">BaseFlutterLocaleSettings</a></li>
        <li><a href="https://pub.dev/documentation/slang/3.13.0/api_singleton/BaseLocaleSettings-class.html">BaseLocaleSettings</a></li>
        <li><a href="https://pub.dev/documentation/slang_flutter/3.13.0/slang_flutter/BaseTranslationProvider-class.html">BaseTranslationProvider</a></li>
        <li><a href="https://pub.dev/documentation/slang/3.13.0/api_locale/BaseTranslations-class.html">BaseTranslations</a></li>
        <li><a href="https://pub.dev/documentation/slang/3.13.0/api_locale/FakeAppLocale-class.html">FakeAppLocale</a></li>
        <li><a href="https://pub.dev/documentation/slang/3.13.0/api_locale/FakeTranslations-class.html">FakeTranslations</a></li>
        <li><a href="https://pub.dev/documentation/slang_flutter/3.13.0/slang_flutter/InheritedLocaleData-class.html">InheritedLocaleData</a></li>
        <li><a href="../i18n_strings.g/LocaleSettings-class.html">LocaleSettings</a></li>
        <li><a href="https://pub.dev/documentation/slang/3.13.0/api_pluralization/PluralResolvers-class.html">PluralResolvers</a></li>
        <li><a href="https://pub.dev/documentation/slang_flutter/3.13.0/slang_flutter/RichPluralResolvers-class.html">RichPluralResolvers</a></li>
        <li><a href="https://pub.dev/documentation/slang/3.13.0/api_locale/TranslationMetadata-class.html">TranslationMetadata</a></li>
        <li><a href="https://pub.dev/documentation/slang_flutter/3.13.0/slang_flutter/TranslationOverridesFlutter-class.html">TranslationOverridesFlutter</a></li>
        <li><a href="../i18n_strings.g/TranslationProvider-class.html">TranslationProvider</a></li>
        <li><a href="../i18n_strings.g/Translations-class.html">Translations</a></li>

      <li class="section-title"><a href="../i18n_strings.g/i18n_strings.g-library.html#extensions">Extensions</a></li>
        <li><a href="https://pub.dev/documentation/slang/3.13.0/api_singleton/AppLocaleUtilsExt.html">AppLocaleUtilsExt</a></li>
        <li><a href="../i18n_strings.g/BuildContextTranslationsExtension.html">BuildContextTranslationsExtension</a></li>
        <li><a href="https://pub.dev/documentation/slang_flutter/3.13.0/slang_flutter/ExtAppLocale.html">ExtAppLocale</a></li>
        <li><a href="https://pub.dev/documentation/slang_flutter/3.13.0/slang_flutter/ExtAppLocaleUtils.html">ExtAppLocaleUtils</a></li>
        <li><a href="https://pub.dev/documentation/slang_flutter/3.13.0/slang_flutter/ExtBaseLocaleSettings.html">ExtBaseLocaleSettings</a></li>
        <li><a href="https://pub.dev/documentation/slang/3.13.0/api_singleton/LocaleSettingsExt.html">LocaleSettingsExt</a></li>



      <li class="section-title"><a href="../i18n_strings.g/i18n_strings.g-library.html#properties">Properties</a></li>
        <li><a href="../i18n_strings.g/t.html">t</a></li>


      <li class="section-title"><a href="../i18n_strings.g/i18n_strings.g-library.html#enums">Enums</a></li>
        <li><a href="../i18n_strings.g/AppLocale.html">AppLocale</a></li>

      <li class="section-title"><a href="../i18n_strings.g/i18n_strings.g-library.html#typedefs">Typedefs</a></li>
        <li><a href="https://pub.dev/documentation/slang_flutter/3.13.0/slang_flutter/InlineSpanBuilder.html">InlineSpanBuilder</a></li>
        <li><a href="https://pub.dev/documentation/slang/3.13.0/api_pluralization/PluralResolver.html">PluralResolver</a></li>
        <li><a href="https://pub.dev/documentation/slang/3.13.0/api_locale/TranslationBuilder.html">TranslationBuilder</a></li>

</ol>

  </div>

  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
    <ol>



        <li class="section-title inherited">
          <a href="../i18n_strings.g/LocaleSettings-class.html#instance-properties">Properties</a>
        </li>
          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></li>
          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></li>
          <li class="inherited"><a href="https://pub.dev/documentation/slang/3.13.0/api_singleton/BaseLocaleSettings/translationMap.html">translationMap</a></li>
          <li class="inherited"><a href="https://pub.dev/documentation/slang/3.13.0/api_singleton/BaseLocaleSettings/utils.html">utils</a></li>

        <li class="section-title inherited"><a href="../i18n_strings.g/LocaleSettings-class.html#instance-methods">Methods</a></li>
          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></li>
          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">toString</a></li>
          <li class="inherited"><a href="https://pub.dev/documentation/slang_flutter/3.13.0/slang_flutter/BaseFlutterLocaleSettings/updateProviderState.html">updateProviderState</a></li>

        <li class="section-title inherited"><a href="../i18n_strings.g/LocaleSettings-class.html#operators">Operators</a></li>
          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></li>


        <li class="section-title"><a href="../i18n_strings.g/LocaleSettings-class.html#static-properties">Static properties</a></li>
          <li><a href="../i18n_strings.g/LocaleSettings/currentLocale.html">currentLocale</a></li>
          <li><a href="../i18n_strings.g/LocaleSettings/instance.html">instance</a></li>
          <li><a class="deprecated" href="../i18n_strings.g/LocaleSettings/supportedLocales.html">supportedLocales</a></li>
          <li><a class="deprecated" href="../i18n_strings.g/LocaleSettings/supportedLocalesRaw.html">supportedLocalesRaw</a></li>

        <li class="section-title"><a href="../i18n_strings.g/LocaleSettings-class.html#static-methods">Static methods</a></li>
          <li><a href="../i18n_strings.g/LocaleSettings/getLocaleStream.html">getLocaleStream</a></li>
          <li><a href="../i18n_strings.g/LocaleSettings/setLocale.html">setLocale</a></li>
          <li><a href="../i18n_strings.g/LocaleSettings/setLocaleRaw.html">setLocaleRaw</a></li>
          <li><a href="../i18n_strings.g/LocaleSettings/setPluralResolver.html">setPluralResolver</a></li>
          <li><a href="../i18n_strings.g/LocaleSettings/useDeviceLocale.html">useDeviceLocale</a></li>

</ol>

  </div><!--/.sidebar-offcanvas-->

</main>

<footer>
  <span class="no-break">
    yuuna
      2.8.0+93
  </span>

  
</footer>



<script src="../static-assets/highlight.pack.js?v1"></script>
<script src="../static-assets/docs.dart.js"></script>



</body>

</html>

